Values Getable by Plugins

Top  Previous  Next

These are invoked when the plugin calls the host function.

 

host->callback_get_strvalue(char* VARIABLENAME, char* destbufm int maxlen):

 

·Handle.MainForm - return the windows Handle for the main FARR form window.

 

·Version.FARR - returns the full version string as shown in about box.

 

·Version.FARR_PLUGINAPI - returns the plugin api version (changes much less frequently)

 

·Version.FARR_PLUGINAPI_RELEASENUM - even simpler # of plugin api to make it easy to test feature compatibility.

 

·EmbeddedWb.Contents - returns contents of embedded web browser html contents (up to maxlen)

 

·EmbeddedWb.ContentsLength - returns a string integer of length of the embedded web browser contents.

 

·pvalue.[VALNAMEHERE] - replace [VALNAMEHERE] with the name of the value you want to ask a plugin to return.  this function will call all plugins get_strvalue(VALNAMEHERE) until one returns a value.  this can be a useful way to get information from other plugins.  no error is reported if no plugin answers (return value will be set to "").  See also the pcommand alias launch string.

 

·resolve:[STRINGHERE] - expand the [STRINGHERE] string of any %KEYWORD% type strings, typically containing virtual path values (see here).

 

·viewmode - returns either: list | memo | html | user | spreadsheet

 

·plugin_alias, plugin_regex, plugin_keywords, plugin_score - returns current value (ie if it has been overridden by user then the overridden value will be returned).

 

·Search.keywords - space separated list of any +keywords passed on search string